home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / program / inter54f.zip / WH_ED114.ZIP / README.TXT < prev    next >
Text File  |  1996-10-27  |  6KB  |  118 lines
  1. WH_Ed114.ZIP includes
  2.  
  3.     README.TXT    1996-10-27    This file.
  4.     WH_wEdit.EXE    1996-10-27    A Windows help file editor, v. 1.14.
  5.     FILE_ID.DIZ    1996-10-27    Identification file.
  6.  
  7. Windows help files can have their initial window position and size defined
  8. at compile time - secondary windows in help files even must have these
  9. properties defined. The position and size are defined as fractions of the
  10. display screen, and therefore it can give inconveniences to carry help files
  11. between different graphics platforms.
  12.  
  13. The WH_wEdit program can edit Windows help files compiled with the HC31 or
  14. HCP help file compilers. WH_wEdit will let you edit both the windows' size and
  15. position, and the background colors of the header and text sections of the
  16. windows. Help files compiled with the HC30 compiler cannot be edited as the
  17. HC30 compiler does not support a [WINDOWS] section in the Help Project File.
  18.  
  19. WH_wEdit also facilitates macro editing. Windows help file macros perform
  20. initialization when the file is loaded by WinHelp. For example, if browsing
  21. is enabled (i.e. if << and >> pushbuttons are available) the help file will
  22. include the macro
  23.     BrowseButtons()
  24. which instructs WinHelp to show the pushbuttons on the button bar. Macro
  25. editing is a delicate matter, and you should not use the macro editor unless
  26. you know what you are doing. You will get the same warning every time you
  27. enable the editor after you have loaded WH_wEdit. For professional help file
  28. authors only: If you start WH_wEdit with four positive integers as parameters,
  29. the macro editor window is opened unconditionally without any warning, with
  30. position and size defined by the four integers (20 320 550 250 is fine for
  31. 800x600+). Only professional help file authors should use this option.
  32.  
  33. Version 1.12+ of WH_wEdit accepts Windows 95 type help files. It can also open
  34. all observed kinds of .MVB (Mulitmedia Viewer Book) files, however, it cannot
  35. edit the windows properties of MVB type 27 files. It will let you know if you
  36. open such file.
  37.  
  38. The program recognizes four types of help files:
  39.     15    Windows 3.0 files (no windows to edit)
  40.     21    Windows 3.1 files and .MVB files
  41.     27    .MVB files (position/size/colors cannot be edited)
  42.     33    Windows 95 files
  43.  
  44. The size of a help file is defined in the file's header. If the physical file
  45. is longer than this size, WH_wEdit will offer to truncate the file. WH_wEdit
  46. cannot edit the file unless it is truncated. A 72 bytes appendix has been
  47. observed to files compiled with RoboHelp. No problems have been observed
  48. truncating such help files. However, truncation is irreversible, so be sure
  49. to have a copy of your help file before you let WH_wEdit truncate it.
  50.  
  51. WH_wEdit is a Windows application program. It is straightforward to use and
  52. has these few lines of online help:
  53.     Select a Help file from the "File" menu
  54.     Select a window to edit from the "Windows" list
  55.     Check appropriate "Defined" checkboxes to enable editing
  56.     Click on the "Change" pushbutton to facilitate editing
  57.     Select the "Edit" menu to enable macros editing
  58. The "WH_wEdit Sample" position and size editor window and the "Color" editor
  59. window have separate online help. The Macros Editor operates almost identical
  60. to Windows' NotePad editor. It includes copy and paste, so that you can copy
  61. macros from one help file - or other sources - to the clipboard, and paste
  62. them into other help files.
  63.  
  64. A few hints are appropriate, though. File|Save will save the current state of
  65. a file unconditionally. File|Open and File|Exit will notify the user about
  66. changes selectively to the Windows part and in the Macros editor, and a save
  67. can be accepted or refused individually; selecting Cancel in any of these two
  68. windows will return you to the current state of the editor. If any changes
  69. were refused, and opening of a file was then canceled in the Open dialog box,
  70. then the changes will remain in the editor, but they are marked as saved.
  71.  
  72. Text can be entered in the Macros editor even if no file is open; WH_wEdit
  73. will offer to copy the editor's contents to the clipboard if you attempt to
  74. save this text or to open a file.
  75.  
  76. The program can report the following errors:
  77.  
  78. Cannot open <name>                Not found, or readonly
  79. <name> has unknown format            Probably not a help file
  80. <name> was compiled with HC30, can't edit    No windows to edit
  81. Insufficient heap for windows in <name>        More local memory needed
  82. No windows were defined in <name>         *)    Compiled without definitions
  83. Cannot reopen <name> for update            Another application deleted
  84. Length of <name> has changed, can't update      or changed the help file
  85. Nothing to save                    Attempt to save unedited file
  86. Window clipped at screen edge            Parts of sample off screen
  87. <name> has MVB type 27 windows. WH_wEdit cannot
  88.   edit position, size and colors of these
  89.   windows.                     *)    Format not supported
  90. Known/Unknown appendix <n> bytes long. Truncate
  91.   after help file?                Truncate in order to edit
  92. *) These are not error messages if the Macros Editor is enabled, then the
  93.    macros can be edited.
  94.  
  95. There are 16 more possible errors concerning the help file format. I would
  96. appreciate to be informed if an error message appear not listed above, or if
  97. the "Insufficient heap" message appears.
  98.  
  99. WH_wEdit is copyright (C) 1994-1996 Bent Lynggaard. The program is freeware,
  100. thus it can be used without any registering. It may be distributed from
  101. Bulletin Board Services.
  102.  
  103. The program may not be included in any commercial software package or
  104. shareware package without my permission. It may be included in public domain
  105. and freeware software packages provided that:
  106.      1. It is included in the original WH_Ed114.ZIP package together with this
  107.         README file, and with my PKZIP authenticity code intact (KJO555).
  108.      2. It is included in the package for a specific help file editing purpose.
  109. I would appreciate to be notified if WH_wEdit is included in a public domain
  110. package.
  111.  
  112. WH_wEdit is supplied without any warranties.
  113.  
  114. Make backups of your help files before you edit them.
  115.  
  116. 1996-10-27.
  117. Bent Lynggaard <bent.lynggaard@risoe.dk> on Internet.
  118.